core/androidx.core.app/[main]SharedElementCallback

SharedElementCallback

abstract class SharedElementCallback(source)

Listener provided in setEnterSharedElementCallback and setExitSharedElementCallback to monitor the Activity transitions. The events can be used to customize Activity Transition behavior.

Constructors

constructor()

Types

OnSharedElementsReadyListener

interface OnSharedElementsReadyListener

Listener to be called after onSharedElementsArrived when the shared elements are ready to be hidden in the source Activity and shown in the destination Activity.

Functions

onCaptureSharedElementSnapshot

open fun onCaptureSharedElementSnapshot(sharedElement: View, viewToGlobalMatrix: Matrix, screenBounds: RectF): Parcelable

Creates a snapshot of a shared element to be used by the remote Activity and reconstituted with onCreateSnapshotView.

onCreateSnapshotView

open fun onCreateSnapshotView(context: Context, snapshot: Parcelable): View

Reconstitutes a snapshot View from a Parcelable returned in onCaptureSharedElementSnapshot to be used in onSharedElementStart and onSharedElementEnd.

onMapSharedElements

open fun onMapSharedElements(names: List<String>, sharedElements: Map<String, View>)

Lets the SharedElementCallback adjust the mapping of shared element names to Views.

onRejectSharedElements

open fun onRejectSharedElements(rejectedSharedElements: List<View>)

Called after onMapSharedElements when transferring shared elements in.

onSharedElementEnd

open fun onSharedElementEnd(sharedElementNames: List<String>, sharedElements: List<View>, sharedElementSnapshots: List<View>)

In Activity Transitions, onSharedElementEnd is called immediately before capturing the end of the shared element state on enter and reenter transitions and immediately before capturing the start of the shared element state for exit and return transitions.

onSharedElementsArrived

open fun onSharedElementsArrived(sharedElementNames: List<String>, sharedElements: List<View>, listener: SharedElementCallback.OnSharedElementsReadyListener)

Called during an Activity Transition when the shared elements have arrived at the final location and are ready to be transferred.

onSharedElementStart

open fun onSharedElementStart(sharedElementNames: List<String>, sharedElements: List<View>, sharedElementSnapshots: List<View>)

In Activity Transitions, onSharedElementStart is called immediately before capturing the start of the shared element state on enter and reenter transitions and immediately before capturing the end of the shared element state for exit and return transitions.